<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: OccupancyGridClientNav</title>
    
    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">
    
    <h1 class="page-title">Class: OccupancyGridClientNav</h1>
    
    



<section>
    
<header>
    <h2>
        <span class="ancestors"><a href="global.html#NAV2D">NAV2D</a>.</span>
    
    OccupancyGridClientNav
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
    
        
<dt>
    <h4 class="name" id="OccupancyGridClientNav"><span class="type-signature"></span>new OccupancyGridClientNav<span class="signature">(options)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        A OccupancyGridClientNav uses an OccupancyGridClient to create a map for use with a Navigator.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>options</code></td>
            
            
            <td class="type">
            
            </td>
            
            
            
            
            
            <td class="description last">object with following keys:
  * ros - the ROSLIB.Ros connection handle
  * topic (optional) - the map topic to listen to
  * rootObject (optional) - the root object to add this marker to
  * continuous (optional) - if the map should be continuously loaded (e.g., for SLAM)
  * serverName (optional) - the action server name to use for navigation, like '/move_base'
  * actionName (optional) - the navigation action name, like 'move_base_msgs/MoveBaseAction'
  * rootObject (optional) - the root object to add the click listeners to and render robot markers to
  * withOrientation (optional) - if the Navigator should consider the robot orientation (default: false)
  * viewer - the main viewer to render to</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="OccupancyGridClientNav.js.html">navigator/OccupancyGridClientNav.js</a>, line 20
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
    
    
    
    
    
    
</dd>

    
    </div>
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</article>

</section>  




</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="NAV2D.Navigator.html">Navigator</a></li><li><a href="NAV2D.OccupancyGridClientNav.html">OccupancyGridClientNav</a></li></ul><h3>Global</h3><ul><li><a href="global.html#NAV2D">NAV2D</a></li></ul>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Mon Jul 08 2013 10:08:38 GMT-0400 (EDT)
</footer>

<script> prettyPrint(); </script>
</body>
</html>
